IRIX Base Documentation 2001 May/SGI IRIX Base Documentation 2001 May.iso/usr/share/catman/p_man/cat3/ifl_c/iflPixel.z/iflPixel

Text File | 1998-10-30 | 7.0 KB | 199 lines

iiiiffffllllPPPPiiiixxxxeeeellll((((3333))))       IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiiffffllllPPPPiiiixxxxeeeellll((((3333))))



NNNNAAAAMMMMEEEE
     iiiiffffllllPPPPiiiixxxxeeeellll - class for pixel abstraction

IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
     This is a base class and therefore has no inheritance.

HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
     #include <ifl/iflCdefs.h>

CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     This class abstracts the concept of a pixel of image data.  It contains
     the data type, the number of channels, and a list of component values.
     Pixels are used as arguments on an iflConverter constructor.

CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
     CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr

          iflPixel *iflPixelCreate(iflDataType type, int nc, void *data)
          iflPixel *iflPixelPixCreate(iflPixel* pix)

     DDDDeeeessssttttrrrruuuuccccttttoooorrrr

          void iflPixelDelete(iflPixel *pixel)


     IIIInnnniiiittttiiiiaaaalllliiiizzzziiiinnnngggg

          void iflPixelConvert(iflPixel *pixel, iflPixel *pix, iflDataType toType, int nc,
                               int *chanList)
          void iflPixelSet(iflPixel *pixel, iflDataType type, int nc, void *data)


     MMMMeeeemmmmbbbbeeeerrrr aaaacccccccceeeessssssss

          void *iflPixelGetData(iflPixel *pixel)
          iflDataType iflPixelGetDataType(iflPixel *pixel)
          double iflPixelGetElem(iflPixel *pixel, int index)
          int iflPixelGetNumChans(iflPixel *pixel)
          void iflPixelSetElem(iflPixel *pixel, double elemValue, int index)
          double iflPixelMin(iflPixel *pixel)
          double iflPixelMax(iflPixel *pixel)


FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
     iiiiffffllllPPPPiiiixxxxeeeellll(((())))

          iflPixel *iflPixelCreate(iflDataType type, int nc, void *data)
          iflPixel *iflPixelPixCreate(iflPixel* pix)







                                                                        PPPPaaaaggggeeee 1111






iiiiffffllllPPPPiiiixxxxeeeellll((((3333))))       IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiiffffllllPPPPiiiixxxxeeeellll((((3333))))



          The first constructor creates a pixel of data type, _t_y_p_e, with _n_c
          channels, and with the component values pointed to by _d_a_t_a.  The
          data values are copied into the iflPixel constructed.  The second
          constructor copies the attributes and data from the iflPixel
          specified by _p_i_x.

     iiiiffffllllPPPPiiiixxxxeeeellllDDDDeeeelllleeeetttteeee(((())))

          void iflPixelDelete(iflPixel *pixel)


     ccccoooonnnnvvvveeeerrrrtttt(((())))

          void iflPixelConvert(iflPixel *pixel, iflPixel *pix, iflDataType toType, int nc,
                               int *chanList)


          This function copies the pixel specified by _p_i_x, converting to the
          new data type, _t_o_T_y_p_e.  A subset of the channels can be selected by
          listing the channels to copy from the source pixel in _c_h_a_n_L_i_s_t.  The
          length of the channel list is given by _n_c.

     ggggeeeettttDDDDaaaattttaaaa(((())))

          void *iflPixelGetData(iflPixel *pixel)


          This function returns a pointer to the pixel component array.  This
          is identical in function to the ((((vvvvooooiiiidddd****)))) cast operation.

     ggggeeeettttDDDDaaaattttaaaaTTTTyyyyppppeeee(((())))

          iflDataType iflPixelGetDataType(iflPixel *pixel)


          This function returns the data type of the pixel.

     ggggeeeettttEEEElllleeeemmmm(((())))

          double iflPixelGetElem(iflPixel *pixel, int index)


          This function returns the pixel component selected by _i_n_d_e_x.  The
          first component is at index zero.  This is identical in function to
          the [[[[]]]] subscript operation.

     ggggeeeettttNNNNuuuummmmCCCChhhhaaaannnnssss(((())))

          int iflPixelGetNumChans(iflPixel *pixel)






                                                                        PPPPaaaaggggeeee 2222






iiiiffffllllPPPPiiiixxxxeeeellll((((3333))))       IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiiffffllllPPPPiiiixxxxeeeellll((((3333))))



          This function returns the number of channels in the pixel.

     mmmmiiiinnnn(((())))

          double iflPixelMin(iflPixel *pixel)


          This function returns the minimum value of the pixel component
          array.

     mmmmaaaaxxxx(((())))

          double iflPixelMax(iflPixel *pixel)


          This function returns the maximum value of the pixel component
          array.

     sssseeeetttt(((())))

          void iflPixelSet(iflPixel *pixel, iflDataType type, int nc, void *data)


          This function initializes the pixel's data type to _t_y_p_e, sets the
          channel count to _n_c, and copies the component values from _d_a_t_a.

     sssseeeettttEEEElllleeeemmmm(((())))

          void iflPixelSetElem(iflPixel *pixel, double elemValue, int index)


          This function sets the pixel component selected by _i_n_d_e_x.  The first
          component is at index zero.

SSSSEEEEEEEE AAAALLLLSSSSOOOO
     iflConverter



















                                                                        PPPPaaaaggggeeee 3333